Skip to main content
PUT
/
api
/
v1
/
agent-configs
/
{kind}
Upsert the non-BYOK portion of an `agent_configs` row. Full-replace semantics — omitted fields revert to NULL / `[]`.
curl --request PUT \
  --url https://api.backside.app/api/v1/agent-configs/{kind} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budget_default_cents": 123,
  "deadline_default_seconds": 123,
  "guardrails": "<unknown>",
  "schedule": "<string>"
}
'
{
  "agent_kind": "<string>",
  "byok_status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "guardrails": "<unknown>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "budget_default_cents": 123,
  "byok_last_probed_at": "2023-11-07T05:31:56Z",
  "byok_status_reason": "<string>",
  "deadline_default_seconds": 123,
  "schedule": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
kind
string
required

Agent kind identifier

Body

application/json

Request body for PUT /agent-configs/{kind}. Full-replace semantics — any field omitted from the body reverts to NULL / []. BYOK key entry is a separate endpoint (PUT /agent-configs/{kind}/byok-key) so raw secrets never flow through the generic upsert path.

​
budget_default_cents
integer<int64> | null

Default budget cap in USD cents for a run enqueued under this kind.

​
deadline_default_seconds
integer<int32> | null

Default wall-clock deadline in seconds from run start.

​
guardrails
any

JSON array of guardrail rule primitives. Defaults to [] if omitted.

​
schedule
string | null

Cron expression (5-field POSIX, extended with seconds optional).

Response

Config upserted

A single agent_configs row as exposed over the REST API. Deliberately omits byok_key_ref and byok_key_version — those never cross the API boundary.

​
agent_kind
string
required
​
byok_status
string
required
​
created_at
string<date-time>
required
​
guardrails
any
required
​
id
string<uuid>
required
​
tenant_id
string<uuid>
required
​
updated_at
string<date-time>
required
​
budget_default_cents
integer<int64> | null
​
byok_last_probed_at
string<date-time> | null
​
byok_status_reason
string | null
​
deadline_default_seconds
integer<int32> | null
​
schedule
string | null